//////////////////////////////////////////////////////////////////////////
//
//  Copyright (c) 2019, Cinesite VFX Ltd. All rights reserved.
//
//  Redistribution and use in source and binary forms, with or without
//  modification, are permitted provided that the following conditions are
//  met:
//
//     * Redistributions of source code must retain the above copyright
//       notice, this list of conditions and the following disclaimer.
//
//     * Redistributions in binary form must reproduce the above copyright
//       notice, this list of conditions and the following disclaimer in the
//       documentation and/or other materials provided with the distribution.
//
//     * Neither the name of Cinesite VFX Ltd. nor the names of any
//       other contributors to this software may be used to endorse or
//       promote products derived from this software without specific prior
//       written permission.
//
//  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
//  IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
//  THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
//  PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
//  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
//  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
//  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
//  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
//  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
//  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
//  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
//////////////////////////////////////////////////////////////////////////
#pragma once

#include "GafferOSL/ShadingEngine.h"

namespace GafferOSL
{

/// ShadingEngineAlgo provides convenience functions to aid the use of
/// GafferOSL::ShadingEngine.
namespace ShadingEngineAlgo
{

/// Returns an RGB CompoundData image representation of the specified shading
/// network output. The output doesn't have to be the networks output and can
/// reference the output of any shader within the network that can be connected
/// to a color input. A copy of the network is taken for shading. Return is as
/// per shadedPointsToImageData, may throw as per ShadingEngine::shade.
///
/// Note: P is set to ( 0, 0, 0 ) for all shading points.
///
/// Note: Shading carried out by this method is not cancellable, and uses a
/// default context. As such, any shaders in the network that query time
/// will use the default frame of 1. This is to allow use in cancel-unaware
/// code paths.
GAFFEROSL_API IECore::CompoundDataPtr shadeUVTexture(
	const IECoreScene::ShaderNetwork *shaderNetwork,
	const Imath::V2i &resolution,
	IECoreScene::ShaderNetwork::Parameter output = IECoreScene::ShaderNetwork::Parameter()
);

}

}
